BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sread100.zip / SREAD.DOC < prev next >

Wrap

Text File | 1992-08-14 | 14KB | 305 lines

Sread Version 1.00 Documentation: LEGAL STUFF: I am responsible for NOTHING! You are using this system totally at your own risk! There is only one file that I write to at this time and that is the answers file. All other files are simply either not used or read only! User takes sole responsibility for security and safety of any data while using this program. Sread is not in the Public Domain. It is shareware. This means that you are free to copy it, upload it to bulletin boards, and share it with friends so long as no modification is made to the files contained in this archive but you must either register it or stop using it after thirty (30) days. No changes made be made to the contents or archive except as required to accommodate the default archive format of a particular BBS. No -AV's or ads for any BBS may be placed on, or in, this archive without the express permission of the author. Files in this archive are: SREAD.EXE <- The main program SREAD.DOC <- This file EXAMPLE1 <- Batch File used to run the door with DOOR.SYS EXAMPLE2 <- Batch File used to run the door with PCBOARD.SYS SREAD.QES <- Sample script file covering two possible scripts SREAD.ANS <- Sample response file REGISTER.FRM <- Registration form FILE_ID.DIZ <- Description file SREAD GENERAL INFORMATION: All lines start with a some form of formatting information or that line will be considered to be the question that you want to ask. The script format is totally compatible with PCBoard's script file while adding ProScript compatibility and my extensions via my own script commands using the D²Script(tm) language. This is basically a full featured multiple script door. Version 1.00 still does not have all the formatting information handlers, but has most everything else taken care of. There is still a known bug if you are using the PCBOARD.SYS version, it does not seem to grab the phone numbers. I am looking into this. In the meantime, those using PCB 14.5 should make a DOOR.SYS file for this door and older PCB (14.0, 1, or 2) should use a converter such as PDFC by Kevin Carr. PCBOARD COMPATIBLE FORMAT INFORMATION: ; Lines that start with a semicolon are all treated as displayed lines but the semicolon is not displayed. There is nothing done with the line, as it is only displayed. PROSCRIPT COMPATIBLE FORMAT INFORMATION: \ All lines that start with this symbol will be treated as a input formatting string. These are the ProScript extensions and I have tried to remain totally compatible with them. They are fully documented in the ProScript documentation. ProScript extensions: \? ;require Y or N response \# ;require numeric response \$ ;require any character as response \_ ;optional but allowed response SREAD FORMAT EXTENSIONS: ! These lines are considered to be comments. They are not displayed nor are they written to the answer file. ] This line will be written to the answer file. This will not be displayed but will be written to the answer file. % This line will be written to the answer file and displayed. You may use any valid variables in this line. $ This indicates that this is a label. The label must be on a line by itself and be the first thing on the line (at the leftmost margin). ^ This is a command line and indicates a D²Script(tm) command. The commands are not case sensitive, so you may enter them in lowercase if you want but recommend uppercase for readability. The following D²Script(tm) commands are currently supported: ABORT This will make the system handle the times when a user does NOT finish a script file. ADJUST This will reset the "starting" pointer so that if you want to save part of your script, but may later need to ^ABORT from this point on. ADJ|{level adjustment} +level will increment the user level by the specified amount. -level will decrement the user level by the specified amount. level will set the user level to the specified amount. ACP|{Acceptance question} Accept the information presented. If the users enters anything other than YES or Y they will exit the door. ASK|{LINES} Ask for a number of lines of text. It will end when you either enter the requested number of lines or press enter making a blank line. CHG|{filename} Change the answer file. This is used to change only the answer file and not both script and answer files. CLS This will clear the screen. DEL|{filename} Delete this file. DSP|{filename} Display a file (G will be appended if the user is in the graphics mode. END Force an exit from the script. This will leave the script. JMP|{$LABEL}|{Yes question} This will make your script file jump to the label if there is a negative response. JPP|{$LABEL} Force a jump to the label. There is no response needed from the user. It will just jump. GOSUB|{$LABEL} Call a label subroutine. You will need to use ^RETURN to get back to continue on. You may nest down no more than 1000 levels. LVL|{MIN}|{MAX}|{$LABEL} This will jump to label if the security level is not in the range of min and max. Currently it only works with DOOR.SYS files. MUL|{$LABEL}|{$LABEL}|{$LABEL} Up to ten labels may be used. I would strongly suggest following this line with some sort of ^JPP| as the command will fall through if there is no valid response returned. NEW|{SCRIPT.QES}|{SCRIPT.ANS} This will make the system react as though you are just starting with a new script file. This command will loose your ^GOSUB| nestings. PAUSE This is used when you want to pause a script. It will present a message to the user to press any key. RETURN Returns from the most frequent gosub. You may nest any number of levels down. (Arbitrary limit is 1000) RTRN|{level} Will set the DOS error_level for when you exit the door. Unless there is an error in the door, this value will be returned. Levels 1 - 30 are reserved for Sread. RUN|{complete DOS line} This will cause your script to end, and then execute this command as though you typed it at the command line. If you are inside of a batch file, you will return back to next line in the batch file directly after the call to sread. SHL|{complete DOS line} This will have sread SHELL out to DOS, retaining sread in memory. You should try to minimize the amount of memory that you need, as sread is still in memory. UPPER This is used to force all information that is written to the answer file will be forced to upper case. When you use ^CHG or ^NEW this will be reset to the normal mode. UPPEROFF Turns off the ^UPPER command. WRITEOFF Disable writing to the answer files. All writing to the answer files will be disabled until the ^WRITEON command. When you use ^CHG or ^NEW this will be reset to the normal mode. WRITEON Renables writing capabilities that was disabled with the WRITEOFF command. This only needs to be used after the WRITEOFF command. REPLACEABLE VARIABLES CURRENTLY SUPPORTED: @NUMCALLS@ Caller number @BPS@ Connect Speed @CITY@ City of the caller @DATAPHONE@ Data phone number @EXPDATE@ Expiration Date @FIRST@ First name with the first letter Capitalized @HOMEPHONE@ Home phone number @LASTDATEON@ Last Date On @LASTTIMEON@ Last Time On @NUMTIMESON@ Number of Times on @SECURITY@ Security Level @USER@ Users full name @Xyz variables: Background (y) (blinking) Foreground (z) (Bold) --------------------------------------------------------------------- Black = 0 8 Black = 0 8 Blue = 1 9 Blue = 1 9 Green = 2 A Green = 2 A Cyan = 3 B Cyan = 3 B Red = 4 C Red = 4 C Magenta = 5 D Magenta = 5 D Yellow = 6 E Yellow = 6 E White = 7 F White = 7 F --------------------------------------------------------------------- This information is included only to show how PCBoard uses the @X variables. Clark Development has created this format. I do NOT claim any rights to this format. Also, I do NOT support the @X00 or @XFF commands in this release. @X00 - Save the current color @XFF - Restore the saved color SETUP: Setup of Sread Version 1.00 is very simple. Create a directory for the files somewhere on your system. You will then have to use a batch file (Examples included) to run the door. There are a number of parameters that need to be given to the door. They are as follows: SREAD DOOR.SYS USERS SREAD.QES SREAD.ANS {option1} {option2} DOOR.SYS can be replaced with PCBOARD.SYS if your system does not support DOOR.SYS files. USERS is the name and path to your users file. SREAD.QES is the name of the script file. SREAD.ANS is the answers file for the script question. Options: /debug - used to debug your scripts. Will create an output of the commands as they happened. /slow - Disable the smart ansi system. This will make the ansi output about 25% slower. Turns of abbreviated ansi color codes. $LABEL - A label to start executing at in a script. Error Levels Currently defined: 1 Unable to open BBS system file (pcboard.sys,door.sys etc) 2 Problem reading BBS system file 3 Unrecognized BBS file type 4 Unable to open pcboard USERS file 5 Invalid User record or problem seeking to user record 6 Problem reading USER record 7 PORT command syntax error 8 Fossil driver specified but no Fossil driver installed 9 Memory allocation problem 10 Script file not found 11 Unable to open answer file 12 Malloc failure 13 Refusal through ^ACP (See documentation for more details) 14 Calloc failure 15 Undefined Door open failure 16 Possible virus infection 30 ^RUN command used 17 - 29 Reserved for SRead 31 - 255 Available for ^RTRN command Acknowledgements: PCBoard is a registered trademark of Clark Development Company, Inc ProScript is a registered trademark of Samuel H. Smith. PDFC is a trademark of Kevin Carr. D²Script is a trademark of D²Software.